KCDeleteItem

KCDeleteItem
Header:	Keychain.h		Carbon status:	Under Evaluation

Deletes a password or other keychain item from the default keychain.

OSStatus KCDeleteItem (
    KCItemRef item
);

Parameter descriptions

item: A reference to the keychain item you wish to delete. If you pass an item that has not been previously added to the keychain, KCDeleteItem does nothing and returns noErr.

function result: A result code. The result code errKCNoDefaultKeychain indicates that no default keychain could be found. The result code errKCInvalidItemRef indicates that the specified keychain item reference was invalid.

DISCUSSION

You can use the KCDeleteItem function to delete a keychain item from the permanent data store of the default keychain. KCDeleteItem will automatically call the function KCUnlock to display the Unlock Keychain dialog box if the keychain containing the item is currently locked.

SPECIAL CONSIDERATIONS

KCDeleteItem does not dispose the memory occupied by the item reference. To do so, call the function KCReleaseItem when you are finished with an item.

VERSION NOTES

Available beginning with Keychain Manager 1.0.